<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: LVD-HT       (Low-Voltage-Detect for HT Products)</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__lvd__ht.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#groups">API Reference</a>  </div>
  <div class="headertitle">
<div class="title">LVD-HT (Low-Voltage-Detect for HT Products)</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<p>The LVD HT driver provides an API to manage the Low Voltage Detection HT block. </p>
<p>The functions and other declarations used in this driver are in cy_lvd_ht.h. You can include cy_pdl.h to get access to all functions and declarations in the PDL.</p>
<p>The LVD block provides a status of currently observed VDDD voltage and triggers an interrupt or fault when the observed voltage crosses an adjusted threshold.</p>
<h1><a class="anchor" id="group_lvd_ht_configuration_considerations"></a>
Configuration Considerations</h1>
<p>To set up an LVD, configure the voltage threshold by the <a class="el" href="group__group__lvd__ht__functions.html#ga25b7d2919798eb6c4731a314802dd12e">Cy_LVD_HT_SetThreshold</a> function, ensure that the LVD block itself and LVD interrupt are disabled (by the <a class="el" href="group__group__lvd__ht__functions.html#gab3ed0995c92e8fd2626e78188d880abb">Cy_LVD_HT_Disable</a> and <a class="el" href="group__group__lvd__ht__functions.html#ga1fcc1feb0c8dbf637cb7ab041ba5132d">Cy_LVD_HT_ClearInterruptMask</a> functions correspondingly) before changing the threshold to prevent propagating a false interrupt. Then configure interrupts by the <a class="el" href="group__group__lvd__ht__functions.html#gaca1409d28cd35e6bef0c2b7c7fbc69b5">Cy_LVD_HT_SetInterruptConfig</a> function, do not forget to initialize an interrupt handler (the interrupt source number is srss_interrupt_IRQn). Then enable LVD by the <a class="el" href="group__group__lvd__ht__functions.html#ga478a3ed7153da53b9024f1f9e2c5a6bb">Cy_LVD_HT_Enable</a> function, then wait for at least 25us to get the circuit stabilized and clear the possible false interrupts by the <a class="el" href="group__group__lvd__ht__functions.html#ga527e07a8564e346631059dacb40a012b">Cy_LVD_HT_ClearInterrupt</a>, and finally the LVD interrupt can be enabled by the <a class="el" href="group__group__lvd__ht__functions.html#ga2cee1d13b28c9f4c8a9fd6d277b8bf57">Cy_LVD_HT_SetInterruptMask</a> function.</p>
<p>For example: </p><div class="fragment"><div class="line">    <a class="code" href="group__group__lvd__ht__functions.html#ga1fcc1feb0c8dbf637cb7ab041ba5132d">Cy_LVD_HT_ClearInterruptMask</a>(<a class="code" href="group__group__lvd__ht__enums.html#gga1b2a8e8437030cff2a1d07bc0cf99167a768243cb02efb16c28dc9da760471897">CY_LVD_HT_SELECT_LVD_1</a>);</div><div class="line">    <a class="code" href="group__group__lvd__ht__functions.html#ga25b7d2919798eb6c4731a314802dd12e">Cy_LVD_HT_SetThreshold</a>(<a class="code" href="group__group__lvd__ht__enums.html#gga1b2a8e8437030cff2a1d07bc0cf99167a768243cb02efb16c28dc9da760471897">CY_LVD_HT_SELECT_LVD_1</a>, <a class="code" href="group__group__lvd__ht__enums.html#gga211f34517c148b27c42e74fdad39bea4a8f52253c4ed8c37fdad30eace8793935">CY_LVD_HT_THRESHOLD_3_3_V</a>);</div><div class="line">    <a class="code" href="group__group__lvd__ht__functions.html#ga3bbc656d9eeb3b58236208a60862792a">Cy_LVD_HT_SetActionConfig</a>(<a class="code" href="group__group__lvd__ht__enums.html#gga1b2a8e8437030cff2a1d07bc0cf99167a768243cb02efb16c28dc9da760471897">CY_LVD_HT_SELECT_LVD_1</a>, <a class="code" href="group__group__lvd__ht__enums.html#ggae8ac30fd1b415a0f62238b5d9b5c0ae7a3534b971fc995722a0a73051023fad87">CY_LVD_HT_ACTION_INTERRUPT</a>);</div><div class="line">    <a class="code" href="group__group__lvd__ht__functions.html#gaca1409d28cd35e6bef0c2b7c7fbc69b5">Cy_LVD_HT_SetInterruptConfig</a>(<a class="code" href="group__group__lvd__ht__enums.html#gga1b2a8e8437030cff2a1d07bc0cf99167a768243cb02efb16c28dc9da760471897">CY_LVD_HT_SELECT_LVD_1</a>, <a class="code" href="group__group__lvd__ht__enums.html#gga821e5da024e543a41e4340f671eb1c19a233047d6afadcc1143b662d5de5a828d">CY_LVD_HT_INTR_BOTH</a>);</div><div class="line">    <a class="code" href="group__group__lvd__ht__functions.html#ga62bb17cc72cf7760bb372597d5540e2b">Cy_LVD_HT_DeepSleepDisable</a>(<a class="code" href="group__group__lvd__ht__enums.html#gga1b2a8e8437030cff2a1d07bc0cf99167a768243cb02efb16c28dc9da760471897">CY_LVD_HT_SELECT_LVD_1</a>);</div><div class="line">    <a class="code" href="group__group__lvd__ht__functions.html#ga478a3ed7153da53b9024f1f9e2c5a6bb">Cy_LVD_HT_Enable</a>(<a class="code" href="group__group__lvd__ht__enums.html#gga1b2a8e8437030cff2a1d07bc0cf99167a768243cb02efb16c28dc9da760471897">CY_LVD_HT_SELECT_LVD_1</a>);</div><div class="line">    <a class="code" href="group__group__syslib__functions.html#ga9d2ffe4829c636ad78eaae5043fd6ae6">Cy_SysLib_DelayUs</a>(20U);</div><div class="line">    <a class="code" href="group__group__lvd__ht__functions.html#ga527e07a8564e346631059dacb40a012b">Cy_LVD_HT_ClearInterrupt</a>(<a class="code" href="group__group__lvd__ht__enums.html#gga1b2a8e8437030cff2a1d07bc0cf99167a768243cb02efb16c28dc9da760471897">CY_LVD_HT_SELECT_LVD_1</a>);</div><div class="line">    <a class="code" href="group__group__lvd__ht__functions.html#ga2cee1d13b28c9f4c8a9fd6d277b8bf57">Cy_LVD_HT_SetInterruptMask</a>(<a class="code" href="group__group__lvd__ht__enums.html#gga1b2a8e8437030cff2a1d07bc0cf99167a768243cb02efb16c28dc9da760471897">CY_LVD_HT_SELECT_LVD_1</a>);</div></div><!-- fragment --><p> Note : If an LVD is required in Deep Sleep mode, then <a class="el" href="group__group__lvd__ht__functions.html#gae9e96a6744bad482ec8247f6139b7f98">Cy_LVD_HT_DeepSleepEnable</a> should be used to enable LVD during Deep Sleep.</p>
<h1><a class="anchor" id="group_lvd_ht_more_information"></a>
More Information</h1>
<p>See the LVD chapter of the device technical reference manual (TRM).</p>
<h1><a class="anchor" id="group_lvd_ht_changelog"></a>
Changelog</h1>
<table class="doxtable">
<tr>
<th>Version</th><th>Changes</th><th>Reason of Change </th></tr>
<tr>
<td>1.20 </td><td>Documentation update  </td></tr>
<tr>
<td>1.10 </td><td>Added support for TRAVEO&trade; II Body Entry devices.<br />
 Changed pre-processor logic so SRSS version 2 is grouped with version 3 instead of version 1. </td><td>Code enhancement and support for new devices.  </td></tr>
<tr>
<td>1.0 </td><td>Initial Version </td><td></td></tr>
</table>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
API Reference</h2></td></tr>
<tr class="memitem:group__group__lvd__ht__macros"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__lvd__ht__macros.html">Macros</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__lvd__ht__functions"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__lvd__ht__functions.html">Functions</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__lvd__ht__enums"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__lvd__ht__enums.html">Enumerated Types</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
